home *** CD-ROM | disk | FTP | other *** search
/ Amiga CD-ROM Collection / Amiga CD-ROM Collection - Auge 4000 and Cactus and Demo Util.iso / auge4000 / 61 / simsmart / simsmart.dok < prev    next >
Text File  |  1991-11-20  |  6KB  |  202 lines
  1.                    A.U.G.E. 4000 Kurzanleitung
  2.            ===========================
  3.           
  4. Bedienungshinweise von der Amiga User Group Einzugsbereich 4000.
  5. Diese Kurzanleitung wurde für A.U.G.E. 4000 geschrieben. Eine Übernahme in
  6. andere Serien ist erlaubt, sofern diese Anleitung komplett(!) übernommen
  7. wird. Da der Club immer für neue PD aufgeschlossen ist, würde er sich
  8. bestimmt über eine Kopie der entsprechenden Disk freuen.  Anschrift:
  9.     A.U.G.E. 4000
  10.         c/o Haus der Jugend
  11.     Lacombletstr. 10
  12.     4000 Düsseldorf 30
  13.        
  14. EINE HAFTUNG FÜR SCHÄDEN DIE EVENTUELL DURCH DIESE ANLEITUNG IN IRGENDEINER
  15. ART UND WEISE ENTSTEHEN IST AUSGESCHLOSSEN!!! 
  16.  
  17. ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ 
  18. Programm: SimSmart V2.10 Amiga
  19. Programmautor: David Simon, Department of Computer Science, University College
  20.                of Swansea, SWANSEA SA2 8PP, United Kingdom
  21. Programmart: Shareware
  22. Fundort: AmigaLibDisk 528
  23.  
  24. Autor Kurzanleitung: Gerhard Heeke, Eichendorffstr. 28, W-4047 Dormagen 5
  25.  
  26. ----------------------------------------------------------------------------
  27.  
  28. 1. Allgemein
  29.  
  30. SIMSMART ist vorallem für Programmierer interessant, die eine möglichst
  31. übersichtliche und aussagekräftige Dokumentation für ihre Programme
  32. erstellen wollen. Mit SIMSMART können die Kommentare und Befehle im Quellcode
  33. beim Ausdruck besonders kenntlich gemacht werden (z.B. Kommentare in Italics
  34. und Befehle in Fettdruck). SIMSMART erlaubt hierbei dem Benutzer die
  35. vollständige Kontrolle über die Attribute. Die Ausgabe kann sowohl auf
  36. einem Drucker, als auch auf den Bildschirm oder in eine andere Datei
  37. erfolgen. 
  38.  
  39. Der Benutzer kann SIMSMART an alle möglichen Programmiersprachen anpassen.
  40. Z.Z werden Konfigurationen für folgende Programmiersprachen mitgeliefert:
  41.  
  42.         C
  43.         C++
  44.         Modula-2
  45.         Pascal
  46.         68000 Assembler
  47.         PostScript
  48.         Ada
  49.         Amiga BASIC
  50.         
  51. 2. Wie arbeitet SIMSMART?
  52.  
  53. SIMSMART ist für die Workbench 1.3 und größer ausgerichtet, da es
  54. ausgiebig von dem Befehl ALIAS macht.
  55.  
  56. Haben Sie nun ein Modula-2 Programm geschrieben und wollen die Ausgabe auf
  57. den Drucker umleiten geben Sie nur MODPRT MeinProgramm.mod ein; wollen Sie
  58. die Ausgabe nur auf dem Bildschirm ansehen, so geben Sie
  59. MODSOW MeinProgramm.mod  im CLI/Shell ein.
  60.  
  61.                 
  62. Es empfiehlt sich SIMSMART im Verzeichnis C: zu installieren.
  63. Die dazugehörigen Konfigurations-Dateien (.keys .com) für die
  64. verschiedenen Programmiersprachen sollten sich im Verzeichnis S: befinden.
  65.  
  66. Der Autor von SIMSMART hat ein File mitgeliefert, welches die Shell-Startup
  67. ergänzen soll. (* Ich persönlich halte es aber für übertrieben, alle ALIAS'e
  68. in die Shell-Startup zu integrieren und empfehle deshalb dort nur die von
  69. einem selbst benötigten dort hinein zu kopieren. *)
  70.  
  71. 3. Der Drucker
  72.  
  73. Der Drucker sollte in der Lage sein, die Attribute FETT, ITALIC und
  74. UNTERSTREICHEN verwenden zu können. (* Daß der Drucker auf der Workbench
  75. korrekt installiert ist, setze ich voraus :-) *)
  76.  
  77. 4. Wie benutze ich SIMSMART?
  78.  
  79.     1. Ein CLI/SHELL Fenster öffnen
  80.     
  81.     2. Wechseln Sie in das Verzeichnis in dem sich das Programm befindet
  82.     
  83.     3. Angenommen, Sie wollen ein Modula-2 Programm auf den Drucker
  84.     ausgeben, tippen sie MODPRT MeinProgramm.mod
  85.     
  86.     4. .., sie wollen die Ausgabe in eine andere Datein umleiten, so geben
  87.     Sie bitte MODSHOW >Ausgabefile MeinProgramm.mod ein
  88.     
  89.     
  90. 5. Wichtige Informationen
  91.  
  92. SIMSMART benötigt jeweils zwei Konfigurations-Dateien. In der Datei ...COM
  93. wird der Aufbau der Kommentare dargestellt. In der Datei ...KEYS werden die
  94. Befehle (Schlüsselwörter) der jeweiligen Programmiersprache aufgelistet.
  95.  
  96. Die Alias-Befehle werden wie folgt aufgebaut:
  97.  
  98. z.B.:
  99.     alias modprt        SimSmart >prt: -Ks:modkeys -Cs:modcom  []
  100.     alias modshow        SimSmart  -Ks:modkeys -Cs:modcom  []
  101.  
  102. Aufruf (ohne ALIAS)
  103.         
  104.     SIMSMART  [ >prt: ]  -K<keywordfile>  -C<commentfile> 
  105.        [-tnn]  [ -r[b][i][u] ]   [ -q[s][d][b][i][u] ]  <filename>
  106.        
  107.  
  108. Die Optionen:
  109.  
  110.         -K    Datei mit den Befehlen (Schlüsselwörtern). Der komplette
  111.         Pfad muß eingegeben werden.
  112.         
  113.     -C    Datei mit Beschreibung des Kommentar-Aufbaus. Auch hier muß
  114.         der komplette Pfad eingegeben werden.
  115.         
  116.     -tnn    Setzt den Tabulator auf nn Leerzeichen voreingestellt sind
  117.         4 Leerzeichen
  118.         
  119.     -r[b][i][u] Setzt das Attribut für die Befehle. Voreingestellt ist
  120.              [b] für FETT (Bold).
  121.             
  122.             Andere Attribut sind:
  123.             [i] = ITALICS
  124.             
  125.             [u] = UNTERSTREICHEN
  126.             
  127.             Eine Kombination der Attribute ist möglich.
  128.             
  129.     -q    Alles was in Anführungszeichen bzw. Hochkommata eingeschlossen
  130.         ist, wird normalerweise nicht mit Attributen versehen. Die 
  131.         Option q schaltet dies aus.
  132.         z.b.
  133.         -qsb Druckt alles was mit Hochkommata begrenzt ist (s=Single)
  134.         
  135.         -qdb .... mit Anführungszeichen (d=double)
  136.         
  137.         -qb  .... sowohl als auch (oder auch -qsdb)
  138.                 
  139.     >PRT:    Umleitung zum Drucker
  140.     
  141.                             
  142. 6. Aufbau der ...KEYS Datei
  143.  
  144. Für jede Programmiersprache muß eine Datei angelegt werden. Die Datei
  145. beeinhaltet eine Liste der Schlüsselwörter (Eins pro Zeile! Ohne Leerzeichen).
  146. Falls sowohl Groß- als auch Kleinschrift unterstützt werden soll, müssen zwei
  147. Einträge vorgenommen werden (1*Groß- , 1* Kleinschrift)
  148.     
  149. 7. Aufbau der ...COM Datei
  150.  
  151. Auch hier gibt es wieder für jede Programmiersprache eine Datei. Hier wird der
  152. Aufbau der Kommentare beschrieben. Diese Dateien bestehen nur aus drei Zeilen
  153.  
  154.     1. Zeile Zeichen(kette) die den Kommentar einleitet
  155.     
  156.     2. Zeile Zeichen(kette) die den Kommentar beendet (falls der
  157.              Kommentar nur bis zum Ende der Zeile geht geben Sie nur 
  158.          "newline" ein)
  159.          
  160.     3. Zeile Attribut b|i|u (s.o.)
  161.     
  162. Beispiel: MODCOM
  163.  
  164.             (*
  165.             *)
  166.             i
  167.                            
  168. Erlaubt eine Programmiersprache mehr als eine Kommentar-Form (z.B. Pascal),
  169. wird die erste Zeile wie folgt aufgebaut : ~~<Nr> , sind zwei
  170. Kommentarformen erlaubt, also ~~2
  171.  
  172. Beispiel: PASCOM
  173.  
  174.             ~~2
  175.             {
  176.             }
  177.             (*
  178.             *)
  179.             i
  180.  
  181. 8. Installation
  182.  
  183.     1. Sie setzen die vom Programmautor mitgelieferte Batch-Datei ein
  184.     
  185.     2. Sie kopieren die benötigten Files selber (besser da nicht alle
  186.     Files von jedem benötigt werden)
  187.     
  188.     Kopieren Sie SIMSMART nach C: ; die benötigten KEYS und COM Dateien 
  189.     nach S: ; ergänzen sie die Datei S:Shell-startup (Beispiele finden
  190.     sie in der Datei APPENDto.shell-startup.
  191.     
  192. Viel Spaß wünscht
  193.  
  194.  
  195.  
  196.             Gerhard!
  197.         
  198.     
  199.             
  200.     
  201.  
  202.